General Embed Methods

Methods and Properties in this section are general to the embed client and are available regardless of which type of embedding operation is going to be used (content, search or hub).

The methods handle the embed client initialization and authentication, while the properties expose details of the embedded client.

Methods

  • init - initialize the embed client
  • login - authenticate the user (username and password) against the host and automatically set the embed cookie
  • loginWinAuth - authenticate the user with Windows Kerberos tokens against the host and automatically set the embed cookie
  • loginSAMLAuth - authenticate the user with SAML tokens against the host and automatically set the embed cookie
  • loginOpenIdAuth - authenticate the user with OpenID OAuth tokens against the host and automatically set the embed cookie
  • setAuthToken - manually set the authentication token into the embed cookie
  • getAuthToken - get the authentication token from the embed cookie
  • SetAuthFailureCallback - set a functional call back when authentication fails

Properties

  • host - get the host address of the current embed client
  • isClientLoaded - gets the status of the embed client
  • isLoggedIn - gets whether the authentication cookie has been set

Key Methods

Click the links below for more on the key methods relating to embedded content, hub or search .